Loading...
 

CX_COUNTER - Counter

CX_COUNTER

Class hierarchy
Description:

A counter is used as a counter that has a specific current value and can be incremented or decremented by a step value.

For representation, a counter can manage format specifications that are used according to the FString command.

Counters can delegate the counter and formatting to other counters via the delegation field. This means that the delegated methods do not work with the counter value, step size, format of this counter but with those of the most delegated counter object.

If the formatting is not to be delegated (but only the counter), then the formatting must be deactivated in the delegated counter via flags. Then the formatting from the output counter is applied again.

A counter is deactivated if the output counter or the most delegated(delegation) counter has been deactivated via flags. A disabled counter is not changed by Incr/Decr and returns the largest possible INTEGER value. Format methods always return an empty string for deactivated counters.

Code example: 
String(CX_COUNTER::firstformat, 120, 20, 110)

String(CX_COUNTER::secondformat, 350, 20, 110)

[ Path(CX_COUNTER::uniqueID) LIGHTRED ] SetFormat
[ Path(CX_COUNTER::mlDescription) ] SetFormat

List of methods (MDI)
Function MA* Parameters Return Brief description
Decr INTEGER Decrease counter
DelegatedDecr INTEGERDecrease (delegated) counter
DelegatedGetFormattedValue STRING (Delegated) counter value, formatted
DelegatedGetStep INTEGER(delegate) increment
DelegatedGetValue INTEGER(Delegate) Counter reading
DelegatedIncr INTEGER(delegate) increment counter
FormattedDecr STRING Decrease and format counter
FormattedDelegatedDecr STRING (Delegate) Decrease and format counter
FormattedDelegatedGetValue
224501		 STRING(Delegated) counter reading, formatted
FormattedDelegatedIncr STRING (Delegate) Increase and format counter
FormattedGetValue
224501		 STRINGCounter reading, formatted
FormattedIncr STRING Counter increase and format
GetActiveCounter CX_COUNTERReturns the counter object used for the delegated methods.
GetActiveFormatStrings
224511		 VECTOR〈STRING〉Returns the format strings used for the FormattedDelegated methods.
GetFormattedValue STRING Counter reading, formatted
GetStep INTEGER Step size
GetValue INTEGER Counter reading
Incr INTEGER Increase counter
Set (INTEGER, INTEGER)
SetStep (INTEGER)
SetValue (INTEGER)
Description STRING
GetDomain INTEGERDomain of this object
GetFormatStrings VECTOR〈STRING〉Returns the format strings of this counter as a vector.
GetSiblings COLLECTION All siblings of this object
GetSiblings2 COLLECTION All siblings of this object
GetSlotEntries VECTOR〈OBJECT〉
Item OBJECT
LastUpdate OBJECT
LastUser INTEGER
link (OBJECT)
NextValidObject OBJECT
PreviousValidObject OBJECT
ReferenceCount INTEGER
RestrictedValidity *
SetDomain INTEGER, INTEGER Set domain
ShortName STRING
Siblings *
SpanDateValidity *
string INTEGER CX_STRING Returns the string representation of the object
Unlink
Unlink2 Remove this object from the list of objects with validity
Valid (OBJECT) INTEGER
ValidSince OBJECT
ValidToday INTEGER Valid today?
ValidUntil OBJECT
VerifySiblings INTEGERCheck ring of exchange objects

* MA = Member Access Function

Data directory (DDI)
Data field Type Reference class I* Brief description
delegation POINTER CX_COUNTER Delegate functions do not use their own counter, but the one linked here
firstFormat STRING Control character for formatting
flags INTEGER Bit 0 set = counter deactivated
Bit 1 set = formatting deactivated
secondFormat STRING Fixed text for formatting
step INTEGER Step size for Incr/Decr
uniqueID STRING *
validity POINTER CX_VALIDITY
value INTEGER Current counter value

I = Indexable data field

Use in AppsWH
Module Brief description
counter.mod Counter base module
countedt.mod Counter editing module
countsel.mod Counter selection module